home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / yell25.zip / YELL2.DOC < prev    next >
Text File  |  1992-07-12  |  10KB  |  232 lines
  1.                     
  2.                        
  3.                      Voodoo Computer Co.
  4.                        (216)-932-4339
  5.                      UsRobotics DS HST
  6.  
  7.                         -==>YELL<==-
  8.                            Ver 2.4
  9.  
  10. ::PURPOSE::
  11.  
  12.      What is Yell? Well, it is a simple chat program that offers
  13. a few added features to SearchLight BBS's chat mode. Yell lets
  14. the user enter a reason for his chat request, it runs a batch
  15. file when the sysop is paged (allowing soundblaster adlib
  16. support), and it offers a split screen chat mode. It also records
  17. users who tried to chat, the date, and the reason they wanted to
  18. chat in a log file so you can get back to them. It wont allow
  19. users to page you more than 5 times in a row if you don't answer.
  20. And, by using SL's EVENT.DEF file you can also set up hours
  21. during the day for the sysop to be available and hours for him to
  22. be not available.
  23.  
  24. ::DISCLAIMER/LICENSE::
  25.      
  26.      Voodoo Computer Co, Franz C. Maruna, and Ralph D. Schaefer
  27. are not responsible for any loss of money, hardware, data, hair,
  28. spouses, mental faculties, so on and so forth. Anything that
  29. happens to you after using this program is not our fault. Things
  30. have changed with the license. I have decided that this version
  31. of YELL is SOOO much better than 2.1 that the public just had to
  32. see it :->. So this is released under Share Ware laws. If you
  33. like YELL and use it, you must register it with in 30 days or you
  34. are breaking the law. You also might notice if it isn't
  35. registered you keep getting this annoying 10 sec. pause when you
  36. run it.... <evil grin>. The registration is in the file YELL2.REG
  37. and if it isn't in the ZIP you got call my BBS and download it.
  38. By registering you will also receive free updates.
  39.  
  40. ::INSTALLATION::
  41.  
  42.      Pretty simple, it can be used on any BBS program, although I
  43. suggest SearchLight. Any BBS program that can pass a users name
  44. with the spaces replaced with underbars to YELL will do. Yell
  45. reads the user name off of the command line. What you have to put
  46. on command line should look something like this:
  47.  
  48.                YELL2.EXE JOE_SCHMOE
  49.  
  50. That is how you might run it from dos. To install it with SL put 
  51.  
  52.                YELL2.EXE %U
  53.  
  54. where SL needs to know the command to run. This will be in the
  55. MENU.EXE feature in SL 2.25 and in the DOORS.DEF file in earlier
  56. versions. Our suggestion is to replace the Chat command with a
  57. sample chat menu (YELL2.MNU) that comes included with this ZIP.
  58. It will give you the following menu when you hit chat from the
  59. main menu.
  60.  
  61. Yell  Node  Mail  Quit
  62.  
  63. this is pretty self explanatory, Yell runs YELL, Node runs SL's
  64. normal chat for inter node chatting, Mail runs the mail function,
  65. and Quit, quits.
  66.            Yell requires a config file (YELL2.CFG) which has the
  67. following format:
  68.  
  69. BBS Number
  70. Sysop Name
  71. Availability 
  72. Use SLColors
  73. Number of Times to Page
  74.  
  75. for example
  76.  
  77. (216)-932-4339
  78. SYSOP
  79. S
  80. Y
  81. 15
  82.  
  83. In the freeware version, the 'S' line was where you put a Y on
  84. for available, or a N for not available. This still holds true,
  85. however you can also no put a S for Scroll Lock determines
  86. availability. This way, then scroll lock is on (you see the
  87. little light on your keyboard) you are available, when it isn't
  88. on, you are un-available. This lets you toggle availability from
  89. front-end programs, or multitaskers without having to login (even
  90. better than SL -GASP-). The second to last line is weather on not
  91. you want to use SL's colors. If so you MUST have your CONFIG.SL2
  92. file in the same directory as YELL. I am not sure if this feature
  93. will work with versions of SL earlier than 2.xx, but it should,
  94. if it doesn't, just put N on this line and YELL will default to
  95. somewhat interesting colors. The '15' line is how many times you
  96. want yell to run the batch file for paging. This is real handy if
  97. you have a long sound file, and only want to hear it a few times
  98. instead of 15...
  99.  
  100.  
  101.      The Sysop name is important. It must be EXACTLY the same way
  102. your BBS will pass it on to YELL. If you have a two word name it
  103. should have the spaces replaced with underbars (_'s). (This part
  104. is case sensitive). We still arn't sure why we put the phone
  105. number field in there. Maybe in a later version we will have it
  106. displayed, maybe not. It doesn't really matter, anything can be
  107. in that field, we just thought is was a good idea at the time.
  108. The beauty of having this config file, is you can create one for
  109. available, one for not available, and then use your EVENT.DEF
  110. file to set times for availability. Just copy the config file
  111. with the Y to YELL2.CFG when you want to be available, and copy
  112. the file with N for not available. 
  113.  
  114.      Please only put this on the lines in the config file with
  115. nothing else on 'em. If you put any comments etc on the line it
  116. will @#%&>? it all up!! :-)...
  117.  
  118. ::HOW YELL WORKS::
  119.  
  120.      When you first enter yell it will load the config file in
  121. and then, depending on various things go one of 3 ways. If you
  122. have chosen scroll lock availability then it will determine
  123. weather or not you can be paged from that. If not it will
  124. determine availability from the config file.
  125.  
  126.      If you are not allowed to page it will say that the sysop is
  127. not available now and exit. Otherwise it will ask the user for a
  128. reason the user wants to chat. If the user has paged you 5 times
  129. in a row, and you haven't answered (or you pressed return) then
  130. YELL will record his reason, display the user name, and then
  131. 'pretend' to page you. It will display the periods, so you can
  132. still chat with him, but it wont run YELL2.BAT.
  133.  
  134. -Note: The Info on last user, and how many times is in YELL2.DAT
  135. which YELL will create. Make sure you don't have anything in
  136. there when installing YELL!-
  137.  
  138. If the user hasn't paged you 5 times it will record the reason,
  139. display the user's name so you know who it is bugging you and run
  140. YELL2.BAT. YELL2.BAT is the file you put your page command. Make
  141. sure you have an @ECHO OFF statement on the first line, and
  142. follow all the commands you put in YELL2.BAT with a >NUL so the
  143. user doesn't see anything. My YELL2.BAT for a Sound Blaster is
  144. like this:
  145.  
  146. @ECHO OFF
  147. VPLAY YELL2.VOC >NUL
  148.  
  149. If you like YELL's old page, use the program SCREAM.EXE which
  150. came with the YELL archive. It's the same beep, and the only
  151. thing that might annoy you is there will be a little pause while
  152. YELL opens a dos shell and runs the batch file....
  153.  
  154.  If you hit return while it is paging, it will stop, and exit the
  155. program. This way you can ignore twit users. If you hit ALT-C
  156. during the page you will enter chat mode. With the addition of
  157. the YELL2.BAT file, you may have to hit return or ALT-C twice,
  158. since YELL is in a dos shell and not scanning input, but so far
  159. it hasn't giving me too much trouble that way.
  160.  
  161.      The last thing that YELL does is record the user's name, the
  162. date, reason they entered for chat, and whether or not you
  163. chatted with him in a file called YELL2.LOG If the last thing on
  164. the line is TRUE then you chatted with him, if it is FALSE then
  165. you didn't. Here's a sample log entry:
  166.      
  167. Voodoo Computer 1992611  Thank you for using Yell!!!     TRUE ---
  168. ------------ ----|--  ------------------------------- ----User's
  169. Name     year|day       reason for chat          did you          
  170.           month                                 chat?   
  171.  
  172.  
  173. ::CHAT MODE::
  174.  
  175.      Well, as promised this version has a good chat mode ;-). The
  176. chat mode is very simple. (Most are) The sysop talks on the top.
  177. The user talks on the bottom. You can talk at the same time (or
  178. damn near close to it) so it saves a LOT of time on users who
  179. type at about 4 words per minute and choose phrases like "No, I
  180. tend to disagree my dear sysop, the answer clearly lies in the
  181. direction of our previous thinking....." (grin). Delete, and the
  182. left and right arrows work. Up arrows and down arrows don't work,
  183. but they might confuse you since the cursor will go all over the
  184. place. Don't worry, you are still typing at the same place. In
  185. general don't trust the cursor in the split screen chat mode.
  186. It's very busy. :->. Escape from either user exits YELL. Oh by
  187. the way, word wrap works now too. We have also changed the
  188. windows so that when you hit return on the last line of text in
  189. your window, it scrolls instead of clears, this is REALLY nice
  190. and handy to have...
  191.  
  192. ::VERSION NOTES::
  193.  
  194. Umm I don't know if you really want to read this but anyways:
  195.  
  196. Yell 2 - Original version. Rewritten after HD crash destroyed
  197. 1.42
  198.  
  199. Yell 2.1 - After a multitude of bugs beta version was released
  200.  
  201. Yell 2.2
  202. Added Split Screen Chat mode & Word Wrap
  203. Added Scroll Lock Availability Check. (Thanks to Jim Barry of CCS
  204. Systems for help on determining Scroll Lock status)
  205.  
  206. Yell 2.3
  207. Added SL Color support
  208. Fixed Bug with Delete past beginning of line and word wrap with
  209. words over 70 characters long.
  210. Fixed Up/Down arrow bug
  211. Added Choice on Scroll Lock so people could still use EVENT.DEF
  212. Added Support for Non-SL systems & Colors
  213.  
  214. Yell 2.4
  215. Made YELL 'Public-Ready' by adding Registration info
  216. and fixing a few bugs.
  217.  
  218. Yell 2.5
  219. Added Scrolling in Chat Mode.
  220. Tried to fix bug with exiting at REASON prompt.
  221. Added batch file support.
  222. Added number of beep support.
  223. Fixed bug with unregistered using bad colors.
  224. Added user only pages 5 times support.
  225.  
  226.  
  227.  
  228. If you have any problems, call me. Don't forget to register!!!
  229.  
  230.  
  231. Voodoo Computer
  232. Company|(216)-932-4339|Fido:1:157/559|SL:250:200/760|